/*
 * Copyright (C) 2013 Manoel Afonso Filho
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package agimagem.context;

import agimagem.populacao.Populacao;
import agimagem.strategy.Crossover;
import agimagem.strategy.Inicializacao;
import agimagem.strategy.Mutacao;
import agimagem.strategy.Replacement;
import agimagem.strategy.Selecao;
import agimagem.util.AGChave;

/**
 * Especificação da estrutura do Algoritmo Genético.
 * @author Manoel Afonso Filho
 */
public abstract class AG {

    /**
     * Quantidade de gerações do algoritmo.
     */
    private static int numGeracoes = 500;

    /**
     * Contador especificando a geração atual.
     */
    private static int geracaoAtual = 0;

    /**
     * Se verdadeiro, indica que o algoritmo usa elitismo.
     */
    private boolean elitismo = true;

    /**
     * Interface para a geração da população inicial.
     */
    private Inicializacao inicializacao;

    /**
     * Interface para o operador de Seleção.
     */
    private Selecao selecao;

    /**
     * Interface para o operador de Crossover.
     */
    private Crossover crossover;

    /**
     * Interface para o operador de Mutação.
     */
    private Mutacao mutacao;

    /**
     * Interface para o operador de Replacement.
     */
    private Replacement replacement;

    /**
     * Cria a população inicial a partir do plaintext.
     * @param imagemOriginal Bytes do plaintext.
     * @return População inicial com os indivíduos derivados do plaintext.
     */
    public abstract Populacao gerarPopulacaoInicial(byte[] imagemOriginal);

    /**
     * Executa uma geração do AG.
     * @param p População atual.
     * @return
     */
    public abstract Populacao executarGeracao(Populacao p);

    /**
     * Decriptografa o ciphertext dado com a chave dada.
     * @param ciphertext Texto cifrado.
     * @param chave Chave de uma geração.
     * @return O texto plano de uma geração.
     */
    public abstract byte[] decriptografar(byte[] ciphertext, AGChave chave);

    /**
     * @return Total de gerações que o AG irá executar.
     */
    public static int getNumGeracoes(){
        return AG.numGeracoes;
    }

    /**
     * @param valor Quantidade de gerações que o AG irá executar.
     */
    public static void setNumGeracoes(int valor){
        AG.numGeracoes = valor;
    }

    /**
     * @return Inteiro indicando a geração atual.
     * <code>geraçãoAtual &isin; [0, {@link AG#numGeracoes}]</code>.
     */
    public static int getGeracaoAtual(){
        return AG.geracaoAtual;
    }

    /**
     * Após executar uma geração, atualiza o contador.
     */
    public static void incrementarGeracao(){
        AG.geracaoAtual += 1;
    }

    /**
     * @return the elitismo
     */
    public boolean isElitismo() {
        return elitismo;
    }

    /**
     * @param elitismo the elitismo to set
     */
    public void setElitismo(boolean elitismo) {
        this.elitismo = elitismo;
    }

    /**
     * @return the inicializacao
     */
    public Inicializacao getInicializacao() {
        return inicializacao;
    }

    /**
     * @param inicializacao the inicializacao to set
     */
    public void setInicializacao(Inicializacao inicializacao) {
        this.inicializacao = inicializacao;
    }

    /**
     * @return the selecao
     */
    public Selecao getSelecao() {
        return selecao;
    }

    /**
     * @param selecao the selecao to set
     */
    public void setSelecao(Selecao selecao) {
        this.selecao = selecao;
    }

    /**
     * @return the crossover
     */
    public Crossover getCrossover() {
        return crossover;
    }

    /**
     * @param crossover the crossover to set
     */
    public void setCrossover(Crossover crossover) {
        this.crossover = crossover;
    }

    /**
     * @return the mutacao
     */
    public Mutacao getMutacao() {
        return mutacao;
    }

    /**
     * @param mutacao the mutacao to set
     */
    public void setMutacao(Mutacao mutacao) {
        this.mutacao = mutacao;
    }

    /**
     * @return the replacement
     */
    public Replacement getReplacement() {
        return replacement;
    }

    /**
     * @param replacement the replacement to set
     */
    public void setReplacement(Replacement replacement) {
        this.replacement = replacement;
    }

    @Override
    public String toString() {
        String s = "Quantidade Gerações: " + AG.numGeracoes +
                "\nQuantidade de Indivíduos: " + Inicializacao.numIndividuos;
        return s;
    }

}
